General script file layout

General script file layout

Section headings

A script file is arranged so that certain types of information can be grouped together into blocks, or sections. Three section headings are used to mark the start of a section: [SETUP], [MACROS] and [CONFIG]. Note the use of square brackets [ ] around each heading.

A preface area also is available before the section headings.

General file format

REM preface text [SETUP] setup text : : [MACROS] macro definitions : : [CONFIG] configuration statements : :

Multiple sections of the same type

Multiple sections of the same type can exist within the same script file. The software that converts the script file for use with the control simply combines all the sections of the same type into a single section of that type.

Preface area

The area above the section headings typically is used for any commentary that isn't suitable for the [SETUP] section. The preface by default is treated as part of the [CONFIG] section, even though it is not labelled as such. REM must be used at the start of each line of comments here.

[SETUP] section

The [SETUP] section is for documenting game setup information. This section is optional, so it can be left out of the script file entirely. The text under [SETUP] can include the name and revison number of the game the script was written for, the name of the author, and any procedures, helps or hints the author wishes to include.

The [SETUP] section is treated as one large comment block, so REM statements are not needed. The [SETUP] section ends when the next section heading or the end of the file is reached.

Sample script file with a [SETUP] section

[MACROS] section

Macros are a way to store portions of control assignments outside the [CONFIG] section. The use of macros in a script file is mostly a matter of organizational style, as the use of macros has no affect on the control's performance. The [MACROS] section is optional, and may be excluded from a script file.

See a script file with macros

See a script file without macros

The construction of macros is explained under the Macros topic.

[CONFIG] section

The [CONFIG] section is really what directs the overall operation of the control in a game. In this section, you can:

Assign keyboard commands to joystick buttons (SENDS statement).
Re-map joystick buttons to DirectInput button positions seen by the game. (IS)

Have a [CONFIG] section in the script file if you have a [SETUP] or [MACROS] section heading. If you do not have [SETUP] or [MACROS] sections, you may exclude the [CONFIG] heading, as the entire file will be interpreted as configuration (including any preface text).